GET api/v{version}/announcements?group[0]={group[0]}&group[1]={group[1]}&language={language}

Gets the list of announcements.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
group

Optional list of group abbreviations to filter by.

 Collection of string

None.
language

Optional language code (for example "en" or "en-CA").

 string

None.
version

The requested API version

 string

Required

Default value is 2.0

Body Parameters

None.

Response Information

Resource Description

Collection of Announcement
NameDescriptionTypeAdditional information
Id

Gets or sets the unique ID of the announcement.

 integer

None.
Content

Gets or sets the content of the announcement. May contain HTML as stored in PASS.

 string

None.
Language

Gets or sets the language identifier of the announcement.

 string

None.

Response Formats

application/json, text/json, application/problem+json

Sample: 
[
  {
    "id": 1,
    "content": "sample string 2",
    "language": "sample string 3"
  },
  {
    "id": 1,
    "content": "sample string 2",
    "language": "sample string 3"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfAnnouncement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
  <Announcement>
    <Content>sample string 2</Content>
    <Id>1</Id>
    <Language>sample string 3</Language>
  </Announcement>
  <Announcement>
    <Content>sample string 2</Content>
    <Id>1</Id>
    <Language>sample string 3</Language>
  </Announcement>
</ArrayOfAnnouncement>